home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 22 / AACD 22.iso / AACD / Online / Apache / include / apache / ap.h < prev    next >
Encoding:
C/C++ Source or Header  |  2001-03-06  |  8.2 KB  |  197 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2000 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Apache" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  *
  54.  * Portions of this software are based upon public domain software
  55.  * originally written at the National Center for Supercomputing Applications,
  56.  * University of Illinois, Urbana-Champaign.
  57.  */
  58.  
  59. /*
  60.  * The ap_vsnprintf/ap_snprintf functions are based on, and used with the
  61.  * permission of, the  SIO stdio-replacement strx_* functions by Panos
  62.  * Tsirigotis <panos@alumni.cs.colorado.edu> for xinetd.
  63.  */
  64.  
  65. #ifndef APACHE_AP_H
  66. #define APACHE_AP_H
  67.  
  68. #ifdef __cplusplus
  69. extern "C" {
  70. #endif
  71.  
  72. API_EXPORT(char *) ap_cpystrn(char *, const char *, size_t);
  73. int ap_slack(int, int);
  74. int ap_execle(const char *, const char *, ...);
  75. int ap_execve(const char *, char * const argv[], char * const envp[]);
  76. API_EXPORT(int) ap_getpass(const char *prompt, char *pwbuf, size_t bufsiz);
  77.  
  78. /* small utility macros to make things easier to read */
  79.  
  80. #ifdef WIN32
  81. #define ap_killpg(x, y)
  82. #else
  83. #ifdef NO_KILLPG
  84. #define ap_killpg(x, y)        (kill (-(x), (y)))
  85. #else
  86. #define ap_killpg(x, y)        (killpg ((x), (y)))
  87. #endif
  88. #endif /* WIN32 */
  89.  
  90. /* ap_vformatter() is a generic printf-style formatting routine
  91.  * with some extensions.  The extensions are:
  92.  *
  93.  * %pA    takes a struct in_addr *, and prints it as a.b.c.d
  94.  * %pI    takes a struct sockaddr_in * and prints it as a.b.c.d:port
  95.  * %pp  takes a void * and outputs it in hex
  96.  *
  97.  * The %p hacks are to force gcc's printf warning code to skip
  98.  * over a pointer argument without complaining.  This does
  99.  * mean that the ANSI-style %p (output a void * in hex format) won't
  100.  * work as expected at all, but that seems to be a fair trade-off
  101.  * for the increased robustness of having printf-warnings work.
  102.  *
  103.  * Additionally, ap_vformatter allows for arbitrary output methods
  104.  * using the ap_vformatter_buff and flush_func.
  105.  *
  106.  * The ap_vformatter_buff has two elements curpos and endpos.
  107.  * curpos is where ap_vformatter will write the next byte of output.
  108.  * It proceeds writing output to curpos, and updating curpos, until
  109.  * either the end of output is reached, or curpos == endpos (i.e. the
  110.  * buffer is full).
  111.  *
  112.  * If the end of output is reached, ap_vformatter returns the
  113.  * number of bytes written.
  114.  *
  115.  * When the buffer is full, the flush_func is called.  The flush_func
  116.  * can return -1 to indicate that no further output should be attempted,
  117.  * and ap_vformatter will return immediately with -1.  Otherwise
  118.  * the flush_func should flush the buffer in whatever manner is
  119.  * appropriate, re-initialize curpos and endpos, and return 0.
  120.  *
  121.  * Note that flush_func is only invoked as a result of attempting to
  122.  * write another byte at curpos when curpos >= endpos.  So for
  123.  * example, it's possible when the output exactly matches the buffer
  124.  * space available that curpos == endpos will be true when
  125.  * ap_vformatter returns.
  126.  *
  127.  * ap_vformatter does not call out to any other code, it is entirely
  128.  * self-contained.  This allows the callers to do things which are
  129.  * otherwise "unsafe".  For example, ap_psprintf uses the "scratch"
  130.  * space at the unallocated end of a block, and doesn't actually
  131.  * complete the allocation until ap_vformatter returns.  ap_psprintf
  132.  * would be completely broken if ap_vformatter were to call anything
  133.  * that used a pool.  Similarly http_bprintf() uses the "scratch"
  134.  * space at the end of its output buffer, and doesn't actually note
  135.  * that the space is in use until it either has to flush the buffer
  136.  * or until ap_vformatter returns.
  137.  */
  138.  
  139. typedef struct {
  140.     char *curpos;
  141.     char *endpos;
  142. } ap_vformatter_buff;
  143.  
  144. API_EXPORT(int) ap_vformatter(int (*flush_func)(ap_vformatter_buff *),
  145.     ap_vformatter_buff *, const char *fmt, va_list ap);
  146.  
  147. /* These are snprintf implementations based on ap_vformatter().
  148.  *
  149.  * Note that various standards and implementations disagree on the return
  150.  * value of snprintf, and side-effects due to %n in the formatting string.
  151.  * ap_snprintf behaves as follows:
  152.  *
  153.  * Process the format string until the entire string is exhausted, or
  154.  * the buffer fills.  If the buffer fills then stop processing immediately
  155.  * (so no further %n arguments are processed), and return the buffer
  156.  * length.  In all cases the buffer is NUL terminated.
  157.  *
  158.  * In no event does ap_snprintf return a negative number.  It's not possible
  159.  * to distinguish between an output which was truncated, and an output which
  160.  * exactly filled the buffer.
  161.  */
  162. API_EXPORT(int) ap_snprintf(char *buf, size_t len, const char *format,...)
  163.                 __attribute__((format(printf,3,4)));
  164. API_EXPORT(int) ap_vsnprintf(char *buf, size_t len, const char *format,
  165.                  va_list ap);
  166. /* Simple BASE64 encode/decode functions.
  167.  * 
  168.  * As we might encode binary strings, hence we require the length of
  169.  * the incoming plain source. And return the length of what we decoded.
  170.  *
  171.  * The decoding function takes any non valid char (i.e. whitespace, \0
  172.  * or anything non A-Z,0-9 etc as terminal.
  173.  * 
  174.  * plain strings/binary sequences are not assumed '\0' terminated. Encoded
  175.  * strings are neither. But propably should.
  176.  *
  177.  */
  178. API_EXPORT(int) ap_base64encode_len(int len);
  179. API_EXPORT(int) ap_base64encode(char * coded_dst, const char *plain_src,int len_plain_src);
  180. API_EXPORT(int) ap_base64encode_binary(char * coded_dst, const unsigned char *plain_src,int len_plain_src);
  181.  
  182. API_EXPORT(int) ap_base64decode_len(const char * coded_src);
  183. API_EXPORT(int) ap_base64decode(char * plain_dst, const char *coded_src);
  184. API_EXPORT(int) ap_base64decode_binary(unsigned char * plain_dst, const char *coded_src);
  185.  
  186. /* Password validation, as used in AuthType Basic which is able to cope
  187.  * (based on the prefix) with the SHA1, Apache's internal MD5 and (depending
  188.  * on your platform either plain or crypt(3) passwords.
  189.  */
  190. API_EXPORT(char *) ap_validate_password(const char *user, const char *passwd, const char *hash);
  191.  
  192. #ifdef __cplusplus
  193. }
  194. #endif
  195.  
  196. #endif    /* !APACHE_AP_H */
  197.